<!DOCTYPE html>
<html lang="zh">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
</head>
<body>
    
<!-- 
    API接口说明文档
    1.请求地址
    2.请求方式
    3.请求参数
    4.返回值

    ## API文档
    地址：https://apidocjs.com/
    1.安装：npm install apidoc -g
    写注释：拷贝文档上的实例
    4.生成api文档：apidoc -i ./routers -o ./apidoc
    说明：编译当前目录下routers文件夹中的所有文件，输出到当前目录下的apidoc文件夹中
    2.项目根目录创建 apidoc.json
    ```json
    {
    "name": "我的项目",
    "version": "1.0.0",
    "description": "项目所有的接口说明文档",
    "title": "接口文档",
    "url" : "http://localhost:8080"
    }
    ```

    3.添加注释：
    ```js
    /**
    * @api {post} /user/login 登录
    * @apiGroup user
    *
    * @apiParam {String} user 用户账号
    * @apiParam {String} pass 用户密码
    *
    * @apiSuccessExample 返回数据示例:
    * {
    *     "err": 1,
    *     "msg": "登录成功",
    *     "user": "zhangsan_123"
    * }
    */
    ```
 -->

</body>
</html>